WorldClient Pro © 1999-2000 Alt-N Technologies. All Rights Reserved. |
|
Remote Administration |
|
To access the web-based Remote Administration interface of WorldClient Pro, point your web browser to port 2001 (default) of your WorldClient Pro Server.
Example: http://mycompany.com:2001
|
Figure 1 WorldClient's Remote Administration web interface. |
When you connect to the Remote Administration interface from a remote location, you will be asked to login. When accessing it from its host machine, you will not need to login. The default parameters for your initial login are:
User
Name: Admin
Password:
WorldClient
(password is case-sensitive)
You can change these parameters by manually editing the WorldClient.ini file, or they can be changed from the Remote Administration web interface after logging in.
You can use the Remote Administration interface to:
Navigation
Bar
The left frame
of the Remote
Administration
web interface contains the Navigation
Bar
(Figure 2).
This tool is used to navigate throughout the various features and
options of the interface.
The bar contains the following controls:
|
|
Start/Stop WC - Use these two controls to start or stop the WorldClient service.
Help - Click this button to open the WorldClient administrator's help system in a separate browser window.
Starting/Stopping the WorldClient Service
Click Start
WC on the
Navigation bar in the left frame to start the WorldClient service.
Click Stop
WC on the
Navigation bar in the left frame to stop the WorldClient service.
WorldClient
Pro's Status Page
When you log in
to the Remote
Administration
interface, the first page that you will see is the Status
page. From here you can: monitor session statistics, monitor active
sessions, and kill active sessions. To reach the Status page from
another location within the Remote Administration interface, click WC
Status
on the Navigation
bar
in the left frame.
|
Figure 3 Remote Administration Interface's Status Page. |
Monitoring
Sessions
Statistics
There is a
session statistics monitor located at the top of the Status
page (Figure 3) of the Remote
Administration
interface. This monitor lists:
Number of currently active sessions.
Maximum number of active sessions allowed.
The date and time that the WorldClient service was last started.
Number of POP sessions initiated by WorldClient Pro.
Number of POP errors that WorldClient Pro has encountered.
Number of SMTP sessions initiated by WorldClient Pro.
Number of SMTP errors encountered by WorldClient Pro.
Number of WorldClient Pro errors.
Monitoring
Active Sessions
Whenever a user
is logged in to WorldClient Pro, an active session entry will appear
for that user on the Status
page of the Remote
Administration
interface (see Figure 4). To refresh this session monitor, click WC
Status on the Navigation
bar.
Each active session monitor entry will list:
The active session's unique session code.
The User.
The User's email address.
The date and time that the session was initiated.
IP address from which the user is connecting to WorldClient Pro.
|
Figure 4 Active User Sessions. |
Killing
Active Sessions
Whenever a user
is logged in to WorldClient Pro, a Kill
Session
button will be located to the right of their Active Session entry on
the Status
page of the Remote
Administration
interface (see Figure 4). Click this button if you wish to stop their
active session. Clicking Kill
Session
is equivalent to forcing the user to be logged out.
Files
Page
Click
Edit
Config
on the Navigation
bar
of the Remote
Administration
interface to move to the Files
page.
From this page, you can edit or view WorldClient's files and
settings. It displays a list and description of all files that can be
edited. This list is built from a file called
"Filelist.dat", which is stored in the
"\WorldClient\Admin-CGI" directory, and contains links to
each of the files listed.
Filelist.dat
File
This
comma-delimited file is used to build the list that is displayed when
you click Edit
Config
on the Navigation
bar
of the Remote
Administration interface.
You can include in this list any filename that you choose, and use
the Files
page to remotely access it. Please provide complete paths to the
files that you want to be able to access.
After each file path, you can place an optional short description of the file, separated from it by a comma. This description will be displayed on the Files page to the right of the filename to which it refers. If you would like to make a listed file "View Only" then place a "Y" after the comment section (also separated by a comma). Files with a "Y" after the comments section will not be editable from the Remote Administration interface.
By using the SectionName=[text] key, you can create a heading for groups of files. This name will appear on the Files page in bold print.
To make it easy to find many files with a common base directory, you can set the SectionDir= key equal to the base directory. The $DIR$ macro always expands to the last defined value for SectionDir.
Example:
SectionName=WorldClient
SectionDir=C:\Program
Files\WorldClient
$DIR$\WorldClient.ini,
WorldClient's primary configuration file
$DIR$\AddrBook.txt,
WorldClient's global address book
$DIR$\Logs\WorldClient.log,
WorldClient's primary log file, Y
SectionDir=C:\MyFiles
$DIR$\notes.txt,
These are some important notes, Y
$DIR$\accounts\customs.txt,
This is a list customers
Editing
Listed Files
Each entry's
file name is a link that will cause the file to be displayed in a
text box for editing. After you have made any desired changes to a
file, click the Save
Changes button.
Editing
*.ini Files
INI files are
treated differently on the Files page. They are not simply opened in
a text box for editing, but are instead opened in an editable form
format. When you include an INI file in your list then you must also
create an additional file of the same name (and in the same
directory) with the file extension "*.DSC". This file is
used for displaying a definition of each INI key, and controls
several important factors that determine how some of the keys
themselves will be displayed.
DSC
(description) Files
DSC files
contain the same entries as the INI files that they are describing.
However, the value of each key should be a description or definition
of the key instead of its corresponding INI value.
Example:
WorldClient.ini
[Directories]
BaseDir=C:\Program
Files\WorldClient
WorldClient.dsc
[Directories]
BaseDir=WorldClient's
root directory.
Several other controls can, and in some cases must, be included in DSC files:
[Heading]:Desc=[HeadingDescrition] - Use this format to cause a section heading to be displayed in bold with its description following.
[Key]=_DONOTSHOW_ - This will prevent the INI key from being displayed on the Files page.
[Key]=[Description]_ENCRYPTED_ - This will cause the value of the INI key to be unencrypted/encrypted when it is displayed or saved. For example: if your User key is being encrypted then this would cause it to be unencrypted before it is displayed. Without this control, it would remain encrypted and you wouldn't be able to see the actual value of the User key.
[PasswordKey]=[Description]_ENCRYPTED_ _PASSWORD_ - This is the same as above except that it will also cause the displayed text to appear as "****". This is usually used for passwords so that if someone were to look at your screen while you were typing it they wouldn't be able to see its actual value.
[Key]=[Description]_DISPLAYONLY_ - This will cause the value of the INI key to be "display only". You will not be able to edit the key from the File page.
[SectionHeading]:NewKeys=_NONEWKEYS_- By default each section provides a text box for adding new INI keys to the file. Use this control if you do not want anyone to be able to add a new INI key to a given section of the file.
Editing
the
WorldClient.ini Settings
Click
Edit
Config
on the Navigation bar
of the Remote Administration interface to
edit WorldClient Pro's properties. This will take you to the Files
page from which you can edit WorldClient Pro's INI file, as well as a
number of other files. After making any changes to a file, always
click Save Changes at the
bottom of the page. For a complete description of the INI file's
sections and controls, see WorldClient's
INI File.
Viewing
the WorldClient Pro Log
Click
Edit
Config
on the Navigation bar
of the Remote Administration interface to
view any of WorldClient's Log files. This will take you to the Files
page from which you click the log file that you wish to view. You can
view the entire file or click [Last 5k]
or [Last 25k] to view a
portion of the file.
Accounts
Page
The Accounts
Page (Figure 5) is used for monitoring and editing your WorldClient
Pro users. You can use also use this page to delete or temporarily
disable a user's account.
|
Figure 5 WorldClient Pro's User List. |
Monitoring
WorldClient
Pro Users
Click Accounts
on the Navigation bar
of the Remote Administration interface to
monitor the WorldClient Pro User List.
This page displays a list of your WorldClient Pro user accounts (see
Figure 5). Each entry in the list contains:
The user's account name.
Full Name.
Number of messages stored in their folders.
Amount of disk space being used by the account.
An Edit User control used for editing user's account settings.
An Enable/Disable button for turning on/off the account.
A Delete button for deleting the user's account.
Editing
User
Settings
Click Accounts
on the Navigation bar
of the Remote Administration interface to
move to the WorldClient Pro User List.
Then click "Edit Account"
in the user entry that you wish to edit (see Figure 5). This will
take you to the Edit page
from which you can edit the user's "User.ini" settings.
This file is stored in each user's root directory. For more
information about the contents of the User.ini file, see: WorldClient
Pro's User INI Files.
Deleting Users
Click Accounts
on the Navigation
bar
of the Remote
Administration
interface to
move to the WorldClient Pro User List. On the right side of each
user entry there is a Delete
button (see Figure 5). Click this button to delete the user - along
with all of their folders and messages. You will be asked to confirm
your decision to delete the user before WorldClient Pro will delete
the files and folders.
Enabling/Disabling
User Accounts
Click Accounts
on the Navigation bar
of the Remote Administration interface to
move
to the WorldClient Pro User List. Contained
in each entry is an Enable/Disable
button (see Figure 5), which can be used to suspend the account's
operation. This button will read either "Disable"
or "Enable"
depending upon the current status of the account.
When "Disable" is clicked, the user's ability to log in to their account will be disabled. If they are already logged in when this button is clicked, their account will not be disabled until either they log out or you "Kill" their active session (see Killing Active Sessions). When a user whose account is disabled attempts to log in, WorldClient Pro will display a message telling them that their account is disabled and they should contact their administrator for more information.
New
User
The New User
control takes you to the new user creation page. On this page you can
specify the New User Sign-in, Password, Full Name, Email Address, and
Default Language for the user. All fields but New User Sign-in are
optional. However, if you do not specify a password when you create
an account, it must be set before the account can be accessed. If you
are utilizing the WorldClient/MDaemon
integration features and you do not set a password when the
account is created, the password will be automatically set according
to the New User Defaults settings in MDaemon. See New
User Defaults in your
MDaemon documentation for more information.
Logging
Out
There is no need
to log out of the Remote
Administration
interface. When you are finished editing or monitoring WorldClient
Pro, simply close your browser.